<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>YmsgIRC: Channel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">YmsgIRC
   </div>
   <div id="projectbrief">Program enabling YMSG clients to use IRC</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_channel.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">Channel Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A channel/chatroom class.  
 <a href="class_channel.html#details">More...</a></p>

<p><code>#include &lt;channel.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a742eb209a98200f540408066b25b02ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_channel.html#a742eb209a98200f540408066b25b02ca">reset</a> ()</td></tr>
<tr class="memdesc:a742eb209a98200f540408066b25b02ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">resets all information about the channel  <a href="#a742eb209a98200f540408066b25b02ca"></a><br/></td></tr>
<tr class="memitem:af2b4b16288cbb2c592b1e0f6486c2430"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_channel.html#af2b4b16288cbb2c592b1e0f6486c2430">Channel</a> ()</td></tr>
<tr class="memdesc:af2b4b16288cbb2c592b1e0f6486c2430"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor. calls <a class="el" href="class_channel.html#a742eb209a98200f540408066b25b02ca" title="resets all information about the channel">reset()</a>  <a href="#af2b4b16288cbb2c592b1e0f6486c2430"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ada27be4a604630621c5de998c7f4a418"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada27be4a604630621c5de998c7f4a418"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_channel.html#ada27be4a604630621c5de998c7f4a418">name</a></td></tr>
<tr class="memdesc:ada27be4a604630621c5de998c7f4a418"><td class="mdescLeft">&#160;</td><td class="mdescRight">explicit name of the chatroom or channel. <br/></td></tr>
<tr class="memitem:af6f2434547b280ffbead9234e9826a74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6f2434547b280ffbead9234e9826a74"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_channel.html#af6f2434547b280ffbead9234e9826a74">topic</a></td></tr>
<tr class="memdesc:af6f2434547b280ffbead9234e9826a74"><td class="mdescLeft">&#160;</td><td class="mdescRight">topic or description text for the chatroom. <br/></td></tr>
<tr class="memitem:afa4729f303f2dc173059a0ad34d5f8dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa4729f303f2dc173059a0ad34d5f8dc"></a>
list&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_channel.html#afa4729f303f2dc173059a0ad34d5f8dc">users</a></td></tr>
<tr class="memdesc:afa4729f303f2dc173059a0ad34d5f8dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">list of usernames occupying the chatroom. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A channel/chatroom class. </p>
<p>... </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af2b4b16288cbb2c592b1e0f6486c2430"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Channel::Channel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>constructor. calls <a class="el" href="class_channel.html#a742eb209a98200f540408066b25b02ca" title="resets all information about the channel">reset()</a> </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="class_channel.html#a742eb209a98200f540408066b25b02ca" title="resets all information about the channel">reset()</a> </dd></dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_channel_af2b4b16288cbb2c592b1e0f6486c2430_cgraph.jpg" border="0" usemap="#class_channel_af2b4b16288cbb2c592b1e0f6486c2430_cgraph" alt=""/></div>
<map name="class_channel_af2b4b16288cbb2c592b1e0f6486c2430_cgraph" id="class_channel_af2b4b16288cbb2c592b1e0f6486c2430_cgraph">
<area shape="rect" id="node3" href="class_channel.html#a742eb209a98200f540408066b25b02ca" title="resets all information about the channel" alt="" coords="179,5,285,32"/></map>
</div>
</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a742eb209a98200f540408066b25b02ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Channel::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>resets all information about the channel </p>
<p>also sets <a class="el" href="class_channel.html#ada27be4a604630621c5de998c7f4a418" title="explicit name of the chatroom or channel.">Channel::name</a> to "#", <a class="el" href="class_channel.html#af6f2434547b280ffbead9234e9826a74" title="topic or description text for the chatroom.">Channel::topic</a> to "IRC Channel"; which is arbitrary (must be changed regardless with any default) </p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_channel_a742eb209a98200f540408066b25b02ca_icgraph.jpg" border="0" usemap="#class_channel_a742eb209a98200f540408066b25b02ca_icgraph" alt=""/></div>
<map name="class_channel_a742eb209a98200f540408066b25b02ca_icgraph" id="class_channel_a742eb209a98200f540408066b25b02ca_icgraph">
<area shape="rect" id="node3" href="class_channel.html#af2b4b16288cbb2c592b1e0f6486c2430" title="constructor. calls reset()" alt="" coords="161,5,285,32"/></map>
</div>
</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="channel_8h.html">channel.h</a></li>
<li>channel.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_channel.html">Channel</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li>
  </ul>
</div>
</body>
</html>
